home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 127 / PC Guia 127.iso / Software / Produtividade / OpenOffice.org 2.0.1 / openofficeorg3.cab / pdb.py < prev    next >
Text File  |  2005-11-19  |  33KB  |  1,046 lines
  1. #! /usr/bin/env python
  2.  
  3. """A Python debugger."""
  4.  
  5. # (See pdb.doc for documentation.)
  6.  
  7. import sys
  8. import linecache
  9. import cmd
  10. import bdb
  11. from repr import Repr
  12. import os
  13. import re
  14. import pprint
  15.  
  16. # Create a custom safe Repr instance and increase its maxstring.
  17. # The default of 30 truncates error messages too easily.
  18. _repr = Repr()
  19. _repr.maxstring = 200
  20. _saferepr = _repr.repr
  21.  
  22. __all__ = ["run", "pm", "Pdb", "runeval", "runctx", "runcall", "set_trace",
  23.            "post_mortem", "help"]
  24.  
  25. def find_function(funcname, filename):
  26.     cre = re.compile(r'def\s+%s\s*[(]' % funcname)
  27.     try:
  28.         fp = open(filename)
  29.     except IOError:
  30.         return None
  31.     # consumer of this info expects the first line to be 1
  32.     lineno = 1
  33.     answer = None
  34.     while 1:
  35.         line = fp.readline()
  36.         if line == '':
  37.             break
  38.         if cre.match(line):
  39.             answer = funcname, filename, lineno
  40.             break
  41.         lineno = lineno + 1
  42.     fp.close()
  43.     return answer
  44.  
  45.  
  46. # Interaction prompt line will separate file and call info from code
  47. # text using value of line_prefix string.  A newline and arrow may
  48. # be to your liking.  You can set it once pdb is imported using the
  49. # command "pdb.line_prefix = '\n% '".
  50. # line_prefix = ': '    # Use this to get the old situation back
  51. line_prefix = '\n-> '   # Probably a better default
  52.  
  53. class Pdb(bdb.Bdb, cmd.Cmd):
  54.  
  55.     def __init__(self):
  56.         bdb.Bdb.__init__(self)
  57.         cmd.Cmd.__init__(self)
  58.         self.prompt = '(Pdb) '
  59.         self.aliases = {}
  60.         # Try to load readline if it exists
  61.         try:
  62.             import readline
  63.         except ImportError:
  64.             pass
  65.  
  66.         # Read $HOME/.pdbrc and ./.pdbrc
  67.         self.rcLines = []
  68.         if 'HOME' in os.environ:
  69.             envHome = os.environ['HOME']
  70.             try:
  71.                 rcFile = open(os.path.join(envHome, ".pdbrc"))
  72.             except IOError:
  73.                 pass
  74.             else:
  75.                 for line in rcFile.readlines():
  76.                     self.rcLines.append(line)
  77.                 rcFile.close()
  78.         try:
  79.             rcFile = open(".pdbrc")
  80.         except IOError:
  81.             pass
  82.         else:
  83.             for line in rcFile.readlines():
  84.                 self.rcLines.append(line)
  85.             rcFile.close()
  86.  
  87.     def reset(self):
  88.         bdb.Bdb.reset(self)
  89.         self.forget()
  90.  
  91.     def forget(self):
  92.         self.lineno = None
  93.         self.stack = []
  94.         self.curindex = 0
  95.         self.curframe = None
  96.  
  97.     def setup(self, f, t):
  98.         self.forget()
  99.         self.stack, self.curindex = self.get_stack(f, t)
  100.         self.curframe = self.stack[self.curindex][0]
  101.         self.execRcLines()
  102.  
  103.     # Can be executed earlier than 'setup' if desired
  104.     def execRcLines(self):
  105.         if self.rcLines:
  106.             # Make local copy because of recursion
  107.             rcLines = self.rcLines
  108.             # executed only once
  109.             self.rcLines = []
  110.             for line in rcLines:
  111.                 line = line[:-1]
  112.                 if len(line) > 0 and line[0] != '#':
  113.                     self.onecmd(line)
  114.  
  115.     # Override Bdb methods
  116.  
  117.     def user_call(self, frame, argument_list):
  118.         """This method is called when there is the remote possibility
  119.         that we ever need to stop in this function."""
  120.         if self.stop_here(frame):
  121.             print '--Call--'
  122.             self.interaction(frame, None)
  123.  
  124.     def user_line(self, frame):
  125.         """This function is called when we stop or break at this line."""
  126.         self.interaction(frame, None)
  127.  
  128.     def user_return(self, frame, return_value):
  129.         """This function is called when a return trap is set here."""
  130.         frame.f_locals['__return__'] = return_value
  131.         print '--Return--'
  132.         self.interaction(frame, None)
  133.  
  134.     def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
  135.         """This function is called if an exception occurs,
  136.         but only if we are to stop at or just below this level."""
  137.         frame.f_locals['__exception__'] = exc_type, exc_value
  138.         if type(exc_type) == type(''):
  139.             exc_type_name = exc_type
  140.         else: exc_type_name = exc_type.__name__
  141.         print exc_type_name + ':', _saferepr(exc_value)
  142.         self.interaction(frame, exc_traceback)
  143.  
  144.     # General interaction function
  145.  
  146.     def interaction(self, frame, traceback):
  147.         self.setup(frame, traceback)
  148.         self.print_stack_entry(self.stack[self.curindex])
  149.         self.cmdloop()
  150.         self.forget()
  151.  
  152.     def default(self, line):
  153.         if line[:1] == '!': line = line[1:]
  154.         locals = self.curframe.f_locals
  155.         globals = self.curframe.f_globals
  156.         try:
  157.             code = compile(line + '\n', '<stdin>', 'single')
  158.             exec code in globals, locals
  159.         except:
  160.             t, v = sys.exc_info()[:2]
  161.             if type(t) == type(''):
  162.                 exc_type_name = t
  163.             else: exc_type_name = t.__name__
  164.             print '***', exc_type_name + ':', v
  165.  
  166.     def precmd(self, line):
  167.         """Handle alias expansion and ';;' separator."""
  168.         if not line.strip():
  169.             return line
  170.         args = line.split()
  171.         while args[0] in self.aliases:
  172.             line = self.aliases[args[0]]
  173.             ii = 1
  174.             for tmpArg in args[1:]:
  175.                 line = line.replace("%" + str(ii),
  176.                                       tmpArg)
  177.                 ii = ii + 1
  178.             line = line.replace("%*", ' '.join(args[1:]))
  179.             args = line.split()
  180.         # split into ';;' separated commands
  181.         # unless it's an alias command
  182.         if args[0] != 'alias':
  183.             marker = line.find(';;')
  184.             if marker >= 0:
  185.                 # queue up everything after marker
  186.                 next = line[marker+2:].lstrip()
  187.                 self.cmdqueue.append(next)
  188.                 line = line[:marker].rstrip()
  189.         return line
  190.  
  191.     # Command definitions, called by cmdloop()
  192.     # The argument is the remaining string on the command line
  193.     # Return true to exit from the command loop
  194.  
  195.     do_h = cmd.Cmd.do_help
  196.  
  197.     def do_break(self, arg, temporary = 0):
  198.         # break [ ([filename:]lineno | function) [, "condition"] ]
  199.         if not arg:
  200.             if self.breaks:  # There's at least one
  201.                 print "Num Type         Disp Enb   Where"
  202.                 for bp in bdb.Breakpoint.bpbynumber:
  203.                     if bp:
  204.                         bp.bpprint()
  205.             return
  206.         # parse arguments; comma has lowest precedence
  207.         # and cannot occur in filename
  208.         filename = None
  209.         lineno = None
  210.         cond = None
  211.         comma = arg.find(',')
  212.         if comma > 0:
  213.             # parse stuff after comma: "condition"
  214.             cond = arg[comma+1:].lstrip()
  215.             arg = arg[:comma].rstrip()
  216.         # parse stuff before comma: [filename:]lineno | function
  217.         colon = arg.rfind(':')
  218.         if colon >= 0:
  219.             filename = arg[:colon].rstrip()
  220.             f = self.lookupmodule(filename)
  221.             if not f:
  222.                 print '*** ', `filename`,
  223.                 print 'not found from sys.path'
  224.                 return
  225.             else:
  226.                 filename = f
  227.             arg = arg[colon+1:].lstrip()
  228.             try:
  229.                 lineno = int(arg)
  230.             except ValueError, msg:
  231.                 print '*** Bad lineno:', arg
  232.                 return
  233.         else:
  234.             # no colon; can be lineno or function
  235.             try:
  236.                 lineno = int(arg)
  237.             except ValueError:
  238.                 try:
  239.                     func = eval(arg,
  240.                                 self.curframe.f_globals,
  241.                                 self.curframe.f_locals)
  242.                 except:
  243.                     func = arg
  244.                 try:
  245.                     if hasattr(func, 'im_func'):
  246.                         func = func.im_func
  247.                     code = func.func_code
  248.                     lineno = code.co_firstlineno
  249.                     filename = code.co_filename
  250.                 except:
  251.                     # last thing to try
  252.                     (ok, filename, ln) = self.lineinfo(arg)
  253.                     if not ok:
  254.                         print '*** The specified object',
  255.                         print `arg`,
  256.                         print 'is not a function'
  257.                         print ('or was not found '
  258.                                'along sys.path.')
  259.                         return
  260.                     lineno = int(ln)
  261.         if not filename:
  262.             filename = self.defaultFile()
  263.         # Check for reasonable breakpoint
  264.         line = self.checkline(filename, lineno)
  265.         if line:
  266.             # now set the break point
  267.             err = self.set_break(filename, line, temporary, cond)
  268.             if err: print '***', err
  269.             else:
  270.                 bp = self.get_breaks(filename, line)[-1]
  271.                 print "Breakpoint %d at %s:%d" % (bp.number,
  272.                                                   bp.file,
  273.                                                   bp.line)
  274.  
  275.     # To be overridden in derived debuggers
  276.     def defaultFile(self):
  277.         """Produce a reasonable default."""
  278.         filename = self.curframe.f_code.co_filename
  279.         if filename == '<string>' and mainpyfile:
  280.             filename = mainpyfile
  281.         return filename
  282.  
  283.     do_b = do_break
  284.  
  285.     def do_tbreak(self, arg):
  286.         self.do_break(arg, 1)
  287.  
  288.     def lineinfo(self, identifier):
  289.         failed = (None, None, None)
  290.         # Input is identifier, may be in single quotes
  291.         idstring = identifier.split("'")
  292.         if len(idstring) == 1:
  293.             # not in single quotes
  294.             id = idstring[0].strip()
  295.         elif len(idstring) == 3:
  296.             # quoted
  297.             id = idstring[1].strip()
  298.         else:
  299.             return failed
  300.         if id == '': return failed
  301.         parts = id.split('.')
  302.         # Protection for derived debuggers
  303.         if parts[0] == 'self':
  304.             del parts[0]
  305.             if len(parts) == 0:
  306.                 return failed
  307.         # Best first guess at file to look at
  308.         fname = self.defaultFile()
  309.         if len(parts) == 1:
  310.             item = parts[0]
  311.         else:
  312.             # More than one part.
  313.             # First is module, second is method/class
  314.             f = self.lookupmodule(parts[0])
  315.             if f:
  316.                 fname = f
  317.             item = parts[1]
  318.         answer = find_function(item, fname)
  319.         return answer or failed
  320.  
  321.     def checkline(self, filename, lineno):
  322.         """Return line number of first line at or after input
  323.         argument such that if the input points to a 'def', the
  324.         returned line number is the first
  325.         non-blank/non-comment line to follow.  If the input
  326.         points to a blank or comment line, return 0.  At end
  327.         of file, also return 0."""
  328.  
  329.         line = linecache.getline(filename, lineno)
  330.         if not line:
  331.             print 'End of file'
  332.             return 0
  333.         line = line.strip()
  334.         # Don't allow setting breakpoint at a blank line
  335.         if (not line or (line[0] == '#') or
  336.              (line[:3] == '"""') or line[:3] == "'''"):
  337.             print '*** Blank or comment'
  338.             return 0
  339.         # When a file is read in and a breakpoint is at
  340.         # the 'def' statement, the system stops there at
  341.         # code parse time.  We don't want that, so all breakpoints
  342.         # set at 'def' statements are moved one line onward
  343.         if line[:3] == 'def':
  344.             instr = ''
  345.             brackets = 0
  346.             while 1:
  347.                 skipone = 0
  348.                 for c in line:
  349.                     if instr:
  350.                         if skipone:
  351.                             skipone = 0
  352.                         elif c == '\\':
  353.                             skipone = 1
  354.                         elif c == instr:
  355.                             instr = ''
  356.                     elif c == '#':
  357.                         break
  358.                     elif c in ('"',"'"):
  359.                         instr = c
  360.                     elif c in ('(','{','['):
  361.                         brackets = brackets + 1
  362.                     elif c in (')','}',']'):
  363.                         brackets = brackets - 1
  364.                 lineno = lineno+1
  365.                 line = linecache.getline(filename, lineno)
  366.                 if not line:
  367.                     print 'end of file'
  368.                     return 0
  369.                 line = line.strip()
  370.                 if not line: continue   # Blank line
  371.                 if brackets <= 0 and line[0] not in ('#','"',"'"):
  372.                     break
  373.         return lineno
  374.  
  375.     def do_enable(self, arg):
  376.         args = arg.split()
  377.         for i in args:
  378.             try:
  379.                 i = int(i)
  380.             except ValueError:
  381.                 print 'Breakpoint index %r is not a number' % i
  382.                 continue
  383.  
  384.             if not (0 <= i < len(bdb.Breakpoint.bpbynumber)):
  385.                 print 'No breakpoint numbered', i
  386.                 continue
  387.  
  388.             bp = bdb.Breakpoint.bpbynumber[i]
  389.             if bp:
  390.                 bp.enable()
  391.  
  392.     def do_disable(self, arg):
  393.         args = arg.split()
  394.         for i in args:
  395.             try:
  396.                 i = int(i)
  397.             except ValueError:
  398.                 print 'Breakpoint index %r is not a number' % i
  399.                 continue
  400.  
  401.             if not (0 <= i < len(bdb.Breakpoint.bpbynumber)):
  402.                 print 'No breakpoint numbered', i
  403.                 continue
  404.  
  405.             bp = bdb.Breakpoint.bpbynumber[i]
  406.             if bp:
  407.                 bp.disable()
  408.  
  409.     def do_condition(self, arg):
  410.         # arg is breakpoint number and condition
  411.         args = arg.split(' ', 1)
  412.         bpnum = int(args[0].strip())
  413.         try:
  414.             cond = args[1]
  415.         except:
  416.             cond = None
  417.         bp = bdb.Breakpoint.bpbynumber[bpnum]
  418.         if bp:
  419.             bp.cond = cond
  420.             if not cond:
  421.                 print 'Breakpoint', bpnum,
  422.                 print 'is now unconditional.'
  423.  
  424.     def do_ignore(self,arg):
  425.         """arg is bp number followed by ignore count."""
  426.         args = arg.split()
  427.         bpnum = int(args[0].strip())
  428.         try:
  429.             count = int(args[1].strip())
  430.         except:
  431.             count = 0
  432.         bp = bdb.Breakpoint.bpbynumber[bpnum]
  433.         if bp:
  434.             bp.ignore = count
  435.             if count > 0:
  436.                 reply = 'Will ignore next '
  437.                 if count > 1:
  438.                     reply = reply + '%d crossings' % count
  439.                 else:
  440.                     reply = reply + '1 crossing'
  441.                 print reply + ' of breakpoint %d.' % bpnum
  442.             else:
  443.                 print 'Will stop next time breakpoint',
  444.                 print bpnum, 'is reached.'
  445.  
  446.     def do_clear(self, arg):
  447.         """Three possibilities, tried in this order:
  448.         clear -> clear all breaks, ask for confirmation
  449.         clear file:lineno -> clear all breaks at file:lineno
  450.         clear bpno bpno ... -> clear breakpoints by number"""
  451.         if not arg:
  452.             try:
  453.                 reply = raw_input('Clear all breaks? ')
  454.             except EOFError:
  455.                 reply = 'no'
  456.             reply = reply.strip().lower()
  457.             if reply in ('y', 'yes'):
  458.                 self.clear_all_breaks()
  459.             return
  460.         if ':' in arg:
  461.             # Make sure it works for "clear C:\foo\bar.py:12"
  462.             i = arg.rfind(':')
  463.             filename = arg[:i]
  464.             arg = arg[i+1:]
  465.             try:
  466.                 lineno = int(arg)
  467.             except:
  468.                 err = "Invalid line number (%s)" % arg
  469.             else:
  470.                 err = self.clear_break(filename, lineno)
  471.             if err: print '***', err
  472.             return
  473.         numberlist = arg.split()
  474.         for i in numberlist:
  475.             err = self.clear_bpbynumber(i)
  476.             if err:
  477.                 print '***', err
  478.             else:
  479.                 print 'Deleted breakpoint %s ' % (i,)
  480.     do_cl = do_clear # 'c' is already an abbreviation for 'continue'
  481.  
  482.     def do_where(self, arg):
  483.         self.print_stack_trace()
  484.     do_w = do_where
  485.     do_bt = do_where
  486.  
  487.     def do_up(self, arg):
  488.         if self.curindex == 0:
  489.             print '*** Oldest frame'
  490.         else:
  491.             self.curindex = self.curindex - 1
  492.             self.curframe = self.stack[self.curindex][0]
  493.             self.print_stack_entry(self.stack[self.curindex])
  494.             self.lineno = None
  495.     do_u = do_up
  496.  
  497.     def do_down(self, arg):
  498.         if self.curindex + 1 == len(self.stack):
  499.             print '*** Newest frame'
  500.         else:
  501.             self.curindex = self.curindex + 1
  502.             self.curframe = self.stack[self.curindex][0]
  503.             self.print_stack_entry(self.stack[self.curindex])
  504.             self.lineno = None
  505.     do_d = do_down
  506.  
  507.     def do_step(self, arg):
  508.         self.set_step()
  509.         return 1
  510.     do_s = do_step
  511.  
  512.     def do_next(self, arg):
  513.         self.set_next(self.curframe)
  514.         return 1
  515.     do_n = do_next
  516.  
  517.     def do_return(self, arg):
  518.         self.set_return(self.curframe)
  519.         return 1
  520.     do_r = do_return
  521.  
  522.     def do_continue(self, arg):
  523.         self.set_continue()
  524.         return 1
  525.     do_c = do_cont = do_continue
  526.  
  527.     def do_jump(self, arg):
  528.         if self.curindex + 1 != len(self.stack):
  529.             print "*** You can only jump within the bottom frame"
  530.             return
  531.         try:
  532.             arg = int(arg)
  533.         except ValueError:
  534.             print "*** The 'jump' command requires a line number."
  535.         else:
  536.             try:
  537.                 # Do the jump, fix up our copy of the stack, and display the
  538.                 # new position
  539.                 self.curframe.f_lineno = arg
  540.                 self.stack[self.curindex] = self.stack[self.curindex][0], arg
  541.                 self.print_stack_entry(self.stack[self.curindex])
  542.             except ValueError, e:
  543.                 print '*** Jump failed:', e
  544.     do_j = do_jump
  545.  
  546.     def do_debug(self, arg):
  547.         sys.settrace(None)
  548.         globals = self.curframe.f_globals
  549.         locals = self.curframe.f_locals
  550.         p = Pdb()
  551.         p.prompt = "(%s) " % self.prompt.strip()
  552.         print "ENTERING RECURSIVE DEBUGGER"
  553.         sys.call_tracing(p.run, (arg, globals, locals))
  554.         print "LEAVING RECURSIVE DEBUGGER"
  555.         sys.settrace(self.trace_dispatch)
  556.         self.lastcmd = p.lastcmd
  557.  
  558.     def do_quit(self, arg):
  559.         self.set_quit()
  560.         return 1
  561.     do_q = do_quit
  562.     do_exit = do_quit
  563.  
  564.     def do_EOF(self, arg):
  565.         print
  566.         self.set_quit()
  567.         return 1
  568.  
  569.     def do_args(self, arg):
  570.         f = self.curframe
  571.         co = f.f_code
  572.         dict = f.f_locals
  573.         n = co.co_argcount
  574.         if co.co_flags & 4: n = n+1
  575.         if co.co_flags & 8: n = n+1
  576.         for i in range(n):
  577.             name = co.co_varnames[i]
  578.             print name, '=',
  579.             if name in dict: print dict[name]
  580.             else: print "*** undefined ***"
  581.     do_a = do_args
  582.  
  583.     def do_retval(self, arg):
  584.         if '__return__' in self.curframe.f_locals:
  585.             print self.curframe.f_locals['__return__']
  586.         else:
  587.             print '*** Not yet returned!'
  588.     do_rv = do_retval
  589.  
  590.     def _getval(self, arg):
  591.         try:
  592.             return eval(arg, self.curframe.f_globals,
  593.                         self.curframe.f_locals)
  594.         except:
  595.             t, v = sys.exc_info()[:2]
  596.             if isinstance(t, str):
  597.                 exc_type_name = t
  598.             else: exc_type_name = t.__name__
  599.             print '***', exc_type_name + ':', `v`
  600.             raise
  601.  
  602.     def do_p(self, arg):
  603.         try:
  604.             print repr(self._getval(arg))
  605.         except:
  606.             pass
  607.  
  608.     def do_pp(self, arg):
  609.         try:
  610.             pprint.pprint(self._getval(arg))
  611.         except:
  612.             pass
  613.  
  614.     def do_list(self, arg):
  615.         self.lastcmd = 'list'
  616.         last = None
  617.         if arg:
  618.             try:
  619.                 x = eval(arg, {}, {})
  620.                 if type(x) == type(()):
  621.                     first, last = x
  622.                     first = int(first)
  623.                     last = int(last)
  624.                     if last < first:
  625.                         # Assume it's a count
  626.                         last = first + last
  627.                 else:
  628.                     first = max(1, int(x) - 5)
  629.             except:
  630.                 print '*** Error in argument:', `arg`
  631.                 return
  632.         elif self.lineno is None:
  633.             first = max(1, self.curframe.f_lineno - 5)
  634.         else:
  635.             first = self.lineno + 1
  636.         if last is None:
  637.             last = first + 10
  638.         filename = self.curframe.f_code.co_filename
  639.         breaklist = self.get_file_breaks(filename)
  640.         try:
  641.             for lineno in range(first, last+1):
  642.                 line = linecache.getline(filename, lineno)
  643.                 if not line:
  644.                     print '[EOF]'
  645.                     break
  646.                 else:
  647.                     s = `lineno`.rjust(3)
  648.                     if len(s) < 4: s = s + ' '
  649.                     if lineno in breaklist: s = s + 'B'
  650.                     else: s = s + ' '
  651.                     if lineno == self.curframe.f_lineno:
  652.                         s = s + '->'
  653.                     print s + '\t' + line,
  654.                     self.lineno = lineno
  655.         except KeyboardInterrupt:
  656.             pass
  657.     do_l = do_list
  658.  
  659.     def do_whatis(self, arg):
  660.         try:
  661.             value = eval(arg, self.curframe.f_globals,
  662.                             self.curframe.f_locals)
  663.         except:
  664.             t, v = sys.exc_info()[:2]
  665.             if type(t) == type(''):
  666.                 exc_type_name = t
  667.             else: exc_type_name = t.__name__
  668.             print '***', exc_type_name + ':', `v`
  669.             return
  670.         code = None
  671.         # Is it a function?
  672.         try: code = value.func_code
  673.         except: pass
  674.         if code:
  675.             print 'Function', code.co_name
  676.             return
  677.         # Is it an instance method?
  678.         try: code = value.im_func.func_code
  679.         except: pass
  680.         if code:
  681.             print 'Method', code.co_name
  682.             return
  683.         # None of the above...
  684.         print type(value)
  685.  
  686.     def do_alias(self, arg):
  687.         args = arg.split()
  688.         if len(args) == 0:
  689.             keys = self.aliases.keys()
  690.             keys.sort()
  691.             for alias in keys:
  692.                 print "%s = %s" % (alias, self.aliases[alias])
  693.             return
  694.         if args[0] in self.aliases and len(args) == 1:
  695.             print "%s = %s" % (args[0], self.aliases[args[0]])
  696.         else:
  697.             self.aliases[args[0]] = ' '.join(args[1:])
  698.  
  699.     def do_unalias(self, arg):
  700.         args = arg.split()
  701.         if len(args) == 0: return
  702.         if args[0] in self.aliases:
  703.             del self.aliases[args[0]]
  704.  
  705.     # Print a traceback starting at the top stack frame.
  706.     # The most recently entered frame is printed last;
  707.     # this is different from dbx and gdb, but consistent with
  708.     # the Python interpreter's stack trace.
  709.     # It is also consistent with the up/down commands (which are
  710.     # compatible with dbx and gdb: up moves towards 'main()'
  711.     # and down moves towards the most recent stack frame).
  712.  
  713.     def print_stack_trace(self):
  714.         try:
  715.             for frame_lineno in self.stack:
  716.                 self.print_stack_entry(frame_lineno)
  717.         except KeyboardInterrupt:
  718.             pass
  719.  
  720.     def print_stack_entry(self, frame_lineno, prompt_prefix=line_prefix):
  721.         frame, lineno = frame_lineno
  722.         if frame is self.curframe:
  723.             print '>',
  724.         else:
  725.             print ' ',
  726.         print self.format_stack_entry(frame_lineno, prompt_prefix)
  727.  
  728.  
  729.     # Help methods (derived from pdb.doc)
  730.  
  731.     def help_help(self):
  732.         self.help_h()
  733.  
  734.     def help_h(self):
  735.         print """h(elp)
  736. Without argument, print the list of available commands.
  737. With a command name as argument, print help about that command
  738. "help pdb" pipes the full documentation file to the $PAGER
  739. "help exec" gives help on the ! command"""
  740.  
  741.     def help_where(self):
  742.         self.help_w()
  743.  
  744.     def help_w(self):
  745.         print """w(here)
  746. Print a stack trace, with the most recent frame at the bottom.
  747. An arrow indicates the "current frame", which determines the
  748. context of most commands.  'bt' is an alias for this command."""
  749.  
  750.     help_bt = help_w
  751.  
  752.     def help_down(self):
  753.         self.help_d()
  754.  
  755.     def help_d(self):
  756.         print """d(own)
  757. Move the current frame one level down in the stack trace
  758. (to an older frame)."""
  759.  
  760.     def help_up(self):
  761.         self.help_u()
  762.  
  763.     def help_u(self):
  764.         print """u(p)
  765. Move the current frame one level up in the stack trace
  766. (to a newer frame)."""
  767.  
  768.     def help_break(self):
  769.         self.help_b()
  770.  
  771.     def help_b(self):
  772.         print """b(reak) ([file:]lineno | function) [, condition]
  773. With a line number argument, set a break there in the current
  774. file.  With a function name, set a break at first executable line
  775. of that function.  Without argument, list all breaks.  If a second
  776. argument is present, it is a string specifying an expression
  777. which must evaluate to true before the breakpoint is honored.
  778.  
  779. The line number may be prefixed with a filename and a colon,
  780. to specify a breakpoint in another file (probably one that
  781. hasn't been loaded yet).  The file is searched for on sys.path;
  782. the .py suffix may be omitted."""
  783.  
  784.     def help_clear(self):
  785.         self.help_cl()
  786.  
  787.     def help_cl(self):
  788.         print "cl(ear) filename:lineno"
  789.         print """cl(ear) [bpnumber [bpnumber...]]
  790. With a space separated list of breakpoint numbers, clear
  791. those breakpoints.  Without argument, clear all breaks (but
  792. first ask confirmation).  With a filename:lineno argument,
  793. clear all breaks at that line in that file.
  794.  
  795. Note that the argument is different from previous versions of
  796. the debugger (in python distributions 1.5.1 and before) where
  797. a linenumber was used instead of either filename:lineno or
  798. breakpoint numbers."""
  799.  
  800.     def help_tbreak(self):
  801.         print """tbreak  same arguments as break, but breakpoint is
  802. removed when first hit."""
  803.  
  804.     def help_enable(self):
  805.         print """enable bpnumber [bpnumber ...]
  806. Enables the breakpoints given as a space separated list of
  807. bp numbers."""
  808.  
  809.     def help_disable(self):
  810.         print """disable bpnumber [bpnumber ...]
  811. Disables the breakpoints given as a space separated list of
  812. bp numbers."""
  813.  
  814.     def help_ignore(self):
  815.         print """ignore bpnumber count
  816. Sets the ignore count for the given breakpoint number.  A breakpoint
  817. becomes active when the ignore count is zero.  When non-zero, the
  818. count is decremented each time the breakpoint is reached and the
  819. breakpoint is not disabled and any associated condition evaluates
  820. to true."""
  821.  
  822.     def help_condition(self):
  823.         print """condition bpnumber str_condition
  824. str_condition is a string specifying an expression which
  825. must evaluate to true before the breakpoint is honored.
  826. If str_condition is absent, any existing condition is removed;
  827. i.e., the breakpoint is made unconditional."""
  828.  
  829.     def help_step(self):
  830.         self.help_s()
  831.  
  832.     def help_s(self):
  833.         print """s(tep)
  834. Execute the current line, stop at the first possible occasion
  835. (either in a function that is called or in the current function)."""
  836.  
  837.     def help_next(self):
  838.         self.help_n()
  839.  
  840.     def help_n(self):
  841.         print """n(ext)
  842. Continue execution until the next line in the current function
  843. is reached or it returns."""
  844.  
  845.     def help_return(self):
  846.         self.help_r()
  847.  
  848.     def help_r(self):
  849.         print """r(eturn)
  850. Continue execution until the current function returns."""
  851.  
  852.     def help_continue(self):
  853.         self.help_c()
  854.  
  855.     def help_cont(self):
  856.         self.help_c()
  857.  
  858.     def help_c(self):
  859.         print """c(ont(inue))
  860. Continue execution, only stop when a breakpoint is encountered."""
  861.  
  862.     def help_jump(self):
  863.         self.help_j()
  864.  
  865.     def help_j(self):
  866.         print """j(ump) lineno
  867. Set the next line that will be executed."""
  868.  
  869.     def help_debug(self):
  870.         print """debug code
  871. Enter a recursive debugger that steps through the code argument
  872. (which is an arbitrary expression or statement to be executed
  873. in the current environment)."""
  874.  
  875.     def help_list(self):
  876.         self.help_l()
  877.  
  878.     def help_l(self):
  879.         print """l(ist) [first [,last]]
  880. List source code for the current file.
  881. Without arguments, list 11 lines around the current line
  882. or continue the previous listing.
  883. With one argument, list 11 lines starting at that line.
  884. With two arguments, list the given range;
  885. if the second argument is less than the first, it is a count."""
  886.  
  887.     def help_args(self):
  888.         self.help_a()
  889.  
  890.     def help_a(self):
  891.         print """a(rgs)
  892. Print the arguments of the current function."""
  893.  
  894.     def help_p(self):
  895.         print """p expression
  896. Print the value of the expression."""
  897.  
  898.     def help_pp(self):
  899.         print """pp expression
  900. Pretty-print the value of the expression."""
  901.  
  902.     def help_exec(self):
  903.         print """(!) statement
  904. Execute the (one-line) statement in the context of
  905. the current stack frame.
  906. The exclamation point can be omitted unless the first word
  907. of the statement resembles a debugger command.
  908. To assign to a global variable you must always prefix the
  909. command with a 'global' command, e.g.:
  910. (Pdb) global list_options; list_options = ['-l']
  911. (Pdb)"""
  912.  
  913.     def help_quit(self):
  914.         self.help_q()
  915.  
  916.     def help_q(self):
  917.         print """q(uit) or exit - Quit from the debugger.
  918. The program being executed is aborted."""
  919.  
  920.     help_exit = help_q
  921.  
  922.     def help_whatis(self):
  923.         print """whatis arg
  924. Prints the type of the argument."""
  925.  
  926.     def help_EOF(self):
  927.         print """EOF
  928. Handles the receipt of EOF as a command."""
  929.  
  930.     def help_alias(self):
  931.         print """alias [name [command [parameter parameter ...] ]]
  932. Creates an alias called 'name' the executes 'command'.  The command
  933. must *not* be enclosed in quotes.  Replaceable parameters are
  934. indicated by %1, %2, and so on, while %* is replaced by all the
  935. parameters.  If no command is given, the current alias for name
  936. is shown. If no name is given, all aliases are listed.
  937.  
  938. Aliases may be nested and can contain anything that can be
  939. legally typed at the pdb prompt.  Note!  You *can* override
  940. internal pdb commands with aliases!  Those internal commands
  941. are then hidden until the alias is removed.  Aliasing is recursively
  942. applied to the first word of the command line; all other words
  943. in the line are left alone.
  944.  
  945. Some useful aliases (especially when placed in the .pdbrc file) are:
  946.  
  947. #Print instance variables (usage "pi classInst")
  948. alias pi for k in %1.__dict__.keys(): print "%1.",k,"=",%1.__dict__[k]
  949.  
  950. #Print instance variables in self
  951. alias ps pi self
  952. """
  953.  
  954.     def help_unalias(self):
  955.         print """unalias name
  956. Deletes the specified alias."""
  957.  
  958.     def help_pdb(self):
  959.         help()
  960.  
  961.     def lookupmodule(self, filename):
  962.         """Helper function for break/clear parsing -- may be overridden."""
  963.         root, ext = os.path.splitext(filename)
  964.         if ext == '':
  965.             filename = filename + '.py'
  966.         if os.path.isabs(filename):
  967.             return filename
  968.         for dirname in sys.path:
  969.             while os.path.islink(dirname):
  970.                 dirname = os.readlink(dirname)
  971.             fullname = os.path.join(dirname, filename)
  972.             if os.path.exists(fullname):
  973.                 return fullname
  974.         return None
  975.  
  976. # Simplified interface
  977.  
  978. def run(statement, globals=None, locals=None):
  979.     Pdb().run(statement, globals, locals)
  980.  
  981. def runeval(expression, globals=None, locals=None):
  982.     return Pdb().runeval(expression, globals, locals)
  983.  
  984. def runctx(statement, globals, locals):
  985.     # B/W compatibility
  986.     run(statement, globals, locals)
  987.  
  988. def runcall(*args):
  989.     return Pdb().runcall(*args)
  990.  
  991. def set_trace():
  992.     Pdb().set_trace()
  993.  
  994. # Post-Mortem interface
  995.  
  996. def post_mortem(t):
  997.     p = Pdb()
  998.     p.reset()
  999.     while t.tb_next is not None:
  1000.         t = t.tb_next
  1001.     p.interaction(t.tb_frame, t)
  1002.  
  1003. def pm():
  1004.     post_mortem(sys.last_traceback)
  1005.  
  1006.  
  1007. # Main program for testing
  1008.  
  1009. TESTCMD = 'import x; x.main()'
  1010.  
  1011. def test():
  1012.     run(TESTCMD)
  1013.  
  1014. # print help
  1015. def help():
  1016.     for dirname in sys.path:
  1017.         fullname = os.path.join(dirname, 'pdb.doc')
  1018.         if os.path.exists(fullname):
  1019.             sts = os.system('${PAGER-more} '+fullname)
  1020.             if sts: print '*** Pager exit status:', sts
  1021.             break
  1022.     else:
  1023.         print 'Sorry, can\'t find the help file "pdb.doc"',
  1024.         print 'along the Python search path'
  1025.  
  1026. mainmodule = ''
  1027. mainpyfile = ''
  1028.  
  1029. # When invoked as main program, invoke the debugger on a script
  1030. if __name__=='__main__':
  1031.     if not sys.argv[1:]:
  1032.         print "usage: pdb.py scriptfile [arg] ..."
  1033.         sys.exit(2)
  1034.  
  1035.     mainpyfile = filename = sys.argv[1]     # Get script filename
  1036.     if not os.path.exists(filename):
  1037.         print 'Error:', `filename`, 'does not exist'
  1038.         sys.exit(1)
  1039.     mainmodule = os.path.basename(filename)
  1040.     del sys.argv[0]         # Hide "pdb.py" from argument list
  1041.  
  1042.     # Insert script directory in front of module search path
  1043.     sys.path.insert(0, os.path.dirname(filename))
  1044.  
  1045.     run('execfile(' + `filename` + ')')
  1046.